dcmotor31.h File Reference

This file contains API for DC Motor 31 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	dcmotor31_t
	DC Motor 31 Click context object. More...
struct	dcmotor31_cfg_t
	DC Motor 31 Click configuration object. More...

Macros
#define	DCMOTOR31_REG_INPUT   0x00
	DC Motor 31 PCA9538A registers.
#define	DCMOTOR31_REG_OUTPUT   0x01
#define	DCMOTOR31_REG_POLARITY   0x02
#define	DCMOTOR31_REG_CONFIG   0x03
#define	DCMOTOR31_PIN_LO   0x01
	DC Motor 31 PCA9538A pin mask.
#define	DCMOTOR31_PIN_TRQ_0   0x02
#define	DCMOTOR31_PIN_TRQ_1   0x04
#define	DCMOTOR31_PIN_TRQ_2   0x08
#define	DCMOTOR31_PIN_TRQ_3   0x10
#define	DCMOTOR31_PIN_TRQ_4   0x20
#define	DCMOTOR31_PINS_TRQ   0x3E
#define	DCMOTOR31_DEFAULT_CONFIG   0xC1
	DC Motor 31 PCA9538A pin direction config.
#define	DCMOTOR31_TORQUE_0   0x00
	DC Motor 31 torque setting.
#define	DCMOTOR31_TORQUE_5   0x01
#define	DCMOTOR31_TORQUE_10   0x02
#define	DCMOTOR31_TORQUE_15   0x03
#define	DCMOTOR31_TORQUE_20   0x04
#define	DCMOTOR31_TORQUE_24   0x05
#define	DCMOTOR31_TORQUE_29   0x06
#define	DCMOTOR31_TORQUE_34   0x07
#define	DCMOTOR31_TORQUE_38   0x08
#define	DCMOTOR31_TORQUE_43   0x09
#define	DCMOTOR31_TORQUE_47   0x0A
#define	DCMOTOR31_TORQUE_51   0x0B
#define	DCMOTOR31_TORQUE_56   0x0C
#define	DCMOTOR31_TORQUE_60   0x0D
#define	DCMOTOR31_TORQUE_63   0x0E
#define	DCMOTOR31_TORQUE_67   0x0F
#define	DCMOTOR31_TORQUE_71   0x10
#define	DCMOTOR31_TORQUE_74   0x11
#define	DCMOTOR31_TORQUE_77   0x12
#define	DCMOTOR31_TORQUE_80   0x13
#define	DCMOTOR31_TORQUE_83   0x14
#define	DCMOTOR31_TORQUE_86   0x15
#define	DCMOTOR31_TORQUE_88   0x16
#define	DCMOTOR31_TORQUE_90   0x17
#define	DCMOTOR31_TORQUE_92   0x18
#define	DCMOTOR31_TORQUE_94   0x19
#define	DCMOTOR31_TORQUE_96   0x1A
#define	DCMOTOR31_TORQUE_97   0x1B
#define	DCMOTOR31_TORQUE_98   0x1C
#define	DCMOTOR31_TORQUE_99   0x1D
#define	DCMOTOR31_TORQUE_100   0x1E
#define	DCMOTOR31_MODE_BRAKE   0
	DC Motor 31 operating mode setting.
#define	DCMOTOR31_MODE_FORWARD   1
#define	DCMOTOR31_MODE_REVERSE   2
#define	DCMOTOR31_DEVICE_ADDRESS_A1A0_00   0x70
	DC Motor 31 device address setting.
#define	DCMOTOR31_DEVICE_ADDRESS_A1A0_01   0x71
#define	DCMOTOR31_DEVICE_ADDRESS_A1A0_10   0x72
#define	DCMOTOR31_DEVICE_ADDRESS_A1A0_11   0x73
#define	DCMOTOR31_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	dcmotor31_return_value_t { DCMOTOR31_OK = 0 , DCMOTOR31_ERROR = -1 }
	DC Motor 31 Click return value data. More...

Functions
void	dcmotor31_cfg_setup (dcmotor31_cfg_t *cfg)
	DC Motor 31 configuration object setup function.
err_t	dcmotor31_init (dcmotor31_t *ctx, dcmotor31_cfg_t *cfg)
	DC Motor 31 initialization function.
err_t	dcmotor31_default_cfg (dcmotor31_t *ctx)
	DC Motor 31 default configuration function.
err_t	dcmotor31_write_reg (dcmotor31_t *ctx, uint8_t reg, uint8_t data_in)
	DC Motor 31 write reg function.
err_t	dcmotor31_read_reg (dcmotor31_t *ctx, uint8_t reg, uint8_t *data_out)
	DC Motor 31 read reg function.
void	dcmotor31_enter_sleep (dcmotor31_t *ctx)
	DC Motor 31 enter sleep mode function.
void	dcmotor31_exit_sleep (dcmotor31_t *ctx)
	DC Motor 31 exit sleep mode function.
void	dcmotor31_enable_device (dcmotor31_t *ctx)
	DC Motor 31 enable device function.
void	dcmotor31_disable_device (dcmotor31_t *ctx)
	DC Motor 31 disable device function.
void	dcmotor31_enable_output (dcmotor31_t *ctx)
	DC Motor 31 enable output function.
void	dcmotor31_disable_output (dcmotor31_t *ctx)
	DC Motor 31 disable output function.
void	dcmotor31_set_forward_dir (dcmotor31_t *ctx)
	DC Motor 31 set forward direction function.
void	dcmotor31_set_reverse_dir (dcmotor31_t *ctx)
	DC Motor 31 set reverse direction function.
uint8_t	dcmotor31_get_int_pin (dcmotor31_t *ctx)
	DC Motor 31 get INT pin function.
err_t	dcmotor31_get_lo_pin (dcmotor31_t *ctx, uint8_t *state)
	DC Motor 31 get LO pin state function.
err_t	dcmotor31_set_torque (dcmotor31_t *ctx, uint8_t torque)
	DC Motor 31 set torque function.
void	dcmotor31_set_mode (dcmotor31_t *ctx, uint8_t mode)
	DC Motor 31 set operation mode function.

Detailed Description

This file contains API for DC Motor 31 Click Driver.

Enumeration Type Documentation

dcmotor31_return_value_t

enum dcmotor31_return_value_t

DC Motor 31 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR31_OK
DCMOTOR31_ERROR